Skip to content

Add dev docs for working with file attachments #4840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Oct 2, 2025
Merged

Add dev docs for working with file attachments #4840

merged 2 commits into from
Oct 2, 2025

Conversation

@seancolsen
Copy link
Contributor

This PR adds a section to our Developer Guide on "Working with file attachments" with the aim of helping contributors (and forgetful maintainers like me) get their local development environment set up to work with our new Files feature

Notes

  • We discussed this a bit in today's team meeting and spent some time debating various approaches to solving several different documentation problems. So to be clear:
    • This PR intends to solve the longer term documentation problem of helping onboard new devs with cogent and concise instructions.
    • This PR does not represent the approach I would want to take to solve the shorter term documentation problem of handing off technical information internally as we build new features.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@seancolsen seancolsen added this to the v0.7.0 milestone Oct 1, 2025
@seancolsen seancolsen added the pr-status: review A PR awaiting review label Oct 1, 2025
@seancolsen
Copy link
Contributor Author

@zackkrida I've assigned you to review this since it seems similar to other docs-related work that you've been responsible for.

Also tagging @mathemancer @pavish and @Anish9901 since we debated this during today's meeting and you might care to weigh in. This PR is to demonstrate what I had in mind.

@zackkrida zackkrida self-requested a review October 2, 2025 14:32
zackkrida
zackkrida approved these changes Oct 2, 2025
View reviewed changes
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, @seancolsen. I pushed a98bf99 to add a missing step for bucket creation in the MinIO UI.

This is what I had in mind as well for this kind of documentation.

@zackkrida zackkrida enabled auto-merge October 2, 2025 14:33
@zackkrida zackkrida added this pull request to the merge queue Oct 2, 2025
@seancolsen seancolsen removed this pull request from the merge queue due to a manual request Oct 2, 2025
@seancolsen
Copy link
Contributor Author

seancolsen commented Oct 2, 2025 •
edited
Loading

@zackkrida

Good point about the bucket creation. I don't see that in your commit though.

What I do see is that you removed "Log in with mathesar/mathesar to see". I think this is important to keep. And you added some text "return to". I don't think that makes sense. The port 9001 URL is for the minio admin panel, not for Mathesar. So it'll be a URL that the developer has never seen before and won't know how to log in to.

I'm a little confused. I'm wondering if maybe you pushed the wrong commit or something?

EDIT: sorry, this all makes sense now that I read it all the way through!

@seancolsen seancolsen added this pull request to the merge queue Oct 2, 2025
Merged via the queue into develop with commit 054cd95 Oct 2, 2025
23 checks passed
@seancolsen seancolsen deleted the file_attachments_dev_docs branch October 2, 2025 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zackkrida zackkrida zackkrida approved these changes

Assignees

@zackkrida zackkrida

Labels

pr-status: review A PR awaiting review

Projects

None yet

Milestone

v0.7.0

Development

Successfully merging this pull request may close these issues.

3 participants

@seancolsen @zackkrida